Skip to content

doc: add how to set up instructions#2585

Open
alerizzo wants to merge 4 commits intomasterfrom
doc-ai-instructions
Open

doc: add how to set up instructions#2585
alerizzo wants to merge 4 commits intomasterfrom
doc-ai-instructions

Conversation

@alerizzo
Copy link
Contributor

@alerizzo alerizzo commented Feb 18, 2026

https://codacy.atlassian.net/browse/CF-2220

👀 Live preview

https://doc-ai-instructions--docs-codacy.netlify.app/codacy-ai/codacy-ai/
image

https://doc-ai-instructions--docs-codacy.netlify.app/repositories-configure/integrations/github-integration/
image

🚧 To do

  • If relevant, include the Jira issue key at the end of the pull request title
  • Perform a self-review of the changes
  • Fix any issues reported by the CI/CD

Copilot AI review requested due to automatic review settings February 18, 2026 15:08
@alerizzo alerizzo requested a review from a team as a code owner February 18, 2026 15:08
@codacy-production
Copy link
Contributor

codacy-production bot commented Feb 18, 2026

Codacy's Analysis Summary

0 new issue (≤ 0 minor issue)
0 new security issue

Review Pull Request in Codacy →

AI Reviewer available: add the codacy-review label to get contextual insights without leaving GitHub.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 18, 2026

Overall readability score: 54.2 (🟢 +0.01)

File Readability
github-integration.md 52.61 (🟢 +0.95)
codacy-ai.md 56.56 (🟢 +0.76)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
github-integration.md 52.61 36.08 11.32 12.7 12.29 7.73
  🟢 +0.95 🟢 +0 🟢 +0.05 🟢 +0.1 🟢 +0.42 🟢 +0.04
codacy-ai.md 56.56 37.4 10.75 11.9 12.12 7.31
  🟢 +0.76 🟢 +0 🟢 +0.06 🟢 +0.2 🟢 +0.12 🟢 +0.06

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.2 43.06 10.93 12.32 12.21 8.01
  🟢 +0.01 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@github-actions github-actions bot temporarily deployed to Netlify February 18, 2026 15:12 Inactive

This comment was marked as resolved.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings February 19, 2026 10:43
@github-actions github-actions bot temporarily deployed to Netlify February 19, 2026 10:45 Inactive

This comment was marked as resolved.

codacy-production[bot]

This comment was marked as outdated.

Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

@codacy-production codacy-production bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

The PR is well-structured and provides clear, actionable instructions for configuring the new 'Custom Instructions' feature for the AI Reviewer. No critical issues or logic errors were identified in the documentation content.

Test plan proposal

  • Verify that the relative link in github-integration.md correctly navigates to the Custom Instructions section in codacy-ai.md.
  • Confirm that the backend correctly processes the configuration file at the specific path .codacy/instructions/review.md.
  • Ensure that the codacy-review label successfully triggers the AI Reviewer on a test repository as described.

About this PR

  • The PR title could be more concise. Consider renaming it to better reflect the specific feature being documented.

Example: doc: add setup guide for AI Reviewer custom instructions


💡 Codacy uses AI. Check for mistakes.

@alerizzo alerizzo requested a review from a team February 19, 2026 11:02
@alerizzo alerizzo enabled auto-merge (squash) February 19, 2026 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments